<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Welcome to Open Allure’s documentation! &mdash; OpenAllure v0.1d29dev (alpha) documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '#',
        VERSION:     '0.1d29dev (alpha)',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="OpenAllure v0.1d29dev (alpha) documentation" href="#" />
    <link rel="next" title="openallure.cfg" href="txt/openallure.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="txt/openallure.html" title="openallure.cfg"
             accesskey="N">next</a> |</li>
        <li><a href="#">OpenAllure v0.1d29dev (alpha) documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="welcome-to-open-allure-s-documentation">
<h1>Welcome to Open Allure&#8217;s documentation!<a class="headerlink" href="#welcome-to-open-allure-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Open Allure aims to be a voice-and-vision enabled dialog system written in <a class="reference external" href="http://www.python.org/">Python</a>.</p>
<p>You might <a class="reference external" href="http://packages.python.org/openallure/">check</a> to see if you are reading the most recent documentation&#8211;and using the most recent
version of Open Allure for that matter.</p>
<p>Edit the openallure.cfg file (see the annotated copy in this documentation) to configure the
location of the initial question/answer/response sequence and other settings as appropriate
for your system.</p>
<p>Open Allure is part of the output of the <a class="reference external" href="http://openallureds.org">Open Allure project</a>.</p>
<p><a class="reference external" href="http://bit.ly/openallure">A collection of short videos</a> about the Open Allure project are available and
there is <a class="reference external" href="http://bit.ly/openalluregg">a Google group you can join</a> for updates and discussion.</p>
</div>
<div class="section" id="cross-platform-status">
<h1>Cross-Platform Status<a class="headerlink" href="#cross-platform-status" title="Permalink to this headline">¶</a></h1>
<p>Open Allure aims to run on Mac, Windows, Linux and mobile phones (iPhone and Android).
Mac and Windows distributions are available for version 0.1d29.</p>
</div>
<div class="section" id="dependencies">
<h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h1>
<p>Open Allure uses <a class="reference external" href="http://www.pygame.org/">pyGame</a> and <a class="reference external" href="http://www.crummy.com/software/BeautifulSoup/">BeautifulSoup</a> and <a class="reference external" href="http://www.nltk.org/download">NLTK</a> (Natural Language Toolkit).</p>
<p>As of version 0.1d18, it also uses <a class="reference external" href="http://www.voidspace.org.uk/python/configobj.html">ConfigObj</a> for configuration file management.</p>
</div>
<div class="section" id="configuration">
<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
<ul>
<li class="toctree-l1"><a class="reference external" href="txt/openallure.html"><cite>openallure.cfg</cite></a></li>
</ul>
</div>
<div class="section" id="modules">
<h1>Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h1>
<ul>
<li class="toctree-l1"><a class="reference external" href="modules/openallure.html"><cite>openallure</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/chat.html"><cite>chat</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/qsequence.html"><cite>qsequence</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/oadb.html"><cite>oadb</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/oagraph.html"><cite>oagraph</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/text.html"><cite>text</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/util.html"><cite>util</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/voice.html"><cite>voice</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/setup.html"><cite>setup</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="modules/pygame2exe.html"><cite>pygame2exe</cite></a></li>
</ul>
</div>
<div class="section" id="txt-documentation">
<h1>TXT Documentation<a class="headerlink" href="#txt-documentation" title="Permalink to this headline">¶</a></h1>
<ul>
<li class="toctree-l1"><a class="reference external" href="txt/CHANGES.html"><cite>CHANGES.txt</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="txt/ethics_notice.html"><cite>ethics_notice.txt</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="txt/LICENSE.html"><cite>LICENSE.txt</cite></a><ul>
<li class="toctree-l2"><a class="reference external" href="txt/LICENSE.html#buzhug">buzhug</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="txt/README.html"><cite>README.txt</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="txt/README.html#open-allure">Open Allure</a><ul>
<li class="toctree-l2"><a class="reference external" href="txt/README.html#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference external" href="txt/README.html#license">License</a></li>
<li class="toctree-l2"><a class="reference external" href="txt/README.html#contributors">Contributors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="txt/welcome.html"><cite>welcome.txt</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="txt/start.html"><cite>start.txt</cite></a></li>
<li class="toctree-l1"><a class="reference external" href="txt/music.html"><cite>music.txt</cite></a></li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="#">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="#">Welcome to Open Allure&#8217;s documentation!</a></li>
<li><a class="reference external" href="#cross-platform-status">Cross-Platform Status</a></li>
<li><a class="reference external" href="#dependencies">Dependencies</a></li>
<li><a class="reference external" href="#configuration">Configuration</a><ul>
</ul>
</li>
<li><a class="reference external" href="#modules">Modules</a><ul>
</ul>
</li>
<li><a class="reference external" href="#txt-documentation">TXT Documentation</a><ul>
</ul>
</li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
</ul>

            <h4>Next topic</h4>
            <p class="topless"><a href="txt/openallure.html"
                                  title="next chapter"><cite>openallure.cfg</cite></a></p>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="txt/openallure.html" title="openallure.cfg"
             >next</a> |</li>
        <li><a href="#">OpenAllure v0.1d29dev (alpha) documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2010, John Graves.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
    </div>
  </body>
</html>